Create adoc PR builder [DOC-276]
#1397
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for hardcore-allen-f5257d ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
JackPGreen
force-pushed
the
add-asciidoc-pr-builder
branch
2 times, most recently
from
df95792 to
821d4b5
Compare
JackPGreen
requested review from
nishaatr and
fantkolja
and removed request for
nishaatr
JackPGreen
changed the title
JackPGreen
changed the title
adoc PR builder [DOC-276]
JackPGreen
force-pushed
the
add-asciidoc-pr-builder
branch
from
821d4b5 to
d9bccb9
Compare
JackPGreen
added a commit
to hazelcast/hazelcast-docs
that referenced
this pull request
Dec 5, 2024
We already need to build the documentation using Antora to check for dead links - currently we log (and fail) if `errors` are introduced, but we can drop to `warn`ings to further improve quality. [Note that it's likely that the existing documentation content _already has these problems_](hazelcast/hz-docs#1397), so until addressed the exiting warnings are going to get flagged again and again. An [example of the output](https://github.com/hazelcast/hz-docs/pull/1399/checks) can be found in [this (dummy) PR](hazelcast/hz-docs#1399). This is an _alternative implementation_ of hazelcast/hz-docs#1397 Fixes: [DOC-276](https://hazelcast.atlassian.net/browse/DOC-276), hazelcast/hz-docs#1397 [DOC-276]: https://hazelcast.atlassian.net/browse/DOC-276?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We want to catch errors/warnings etc before they are merged.
This PR adds a PR builder action that checks for asciidoc markup issues, failing if any are found.
Action is deliberately modular to be be easily applied to other docs repos.
In isolation this does nothing but alert the
GITHUB_ACTOR, but in future could be a mandatory check to block a PR merge.Note that these checks currently fail on
mainso merging without addressing those will cause noisier PRs. Another option would be to test only changed files and increment coverage that way - but then intra-document links may not be tested properly.Example of build output:
Fixes: DOC-276, hazelcast/hazelcast-docs#422